curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/employees/{employee_external_id}/vacancies/{vacancy_external_id}/match \
  --header 'Authorization: Bearer <token>'
{
  "employee_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "vacancy_id": "b003505-eb84-42dc-a79f-5e7b1fe897b7",
  "score": 0.87657
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

employee_external_id
string
required

Unique external ID linked to this Employee, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100
vacancy_external_id
string
required

Unique external ID linked to this Vacancy, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Query Parameters

response_format
enum<string>
default:
simple

If set to explained, the response will include an explanation of the match.

Available options:
simple,
explained
include
enum<string>[]

Additional entity attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes.

Available options:
relevant_experience

Response

200
application/json
OK

A match result between an Employee and a Vacancy.

employee_id
string
required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100
vacancy_id
string
required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100
score
number
required

The matching score between an Employee and Vacancy, expressed as a number between 0 and 1.

Required range: 0 < x < 1